知识库列表#

curl -X POST 'https://HOST:PORT/api/v1/third_interface/knowledge/list'

鉴权#

出于安全考虑，必须将 TOKEN 存储于服务端并通过后端接口调用，避免在前端代码中直接暴露，以防止凭证泄露造成损失

请在 HTTP 请求的 Authorization 请求头中包含您的 TOKEN，格式如下：

Authorization: Bearer {YOUR_TOKEN}

TOKEN获取可通过 个人令牌 和 OAuth 应用获取，具体见 个人令牌授权，OAuth 授权码授权

应用秘钥private_key 的获取具体见 生成应用密钥

Request body#

• name (str): 知识库名称（模糊搜索）
• type (int): 知识库类型 0全部 1文本 2表格 3图片 4音频 5应用 6网址 7问答
• tag_id (int): 标签ID
• team_id (int): 团队ID
• page_num (int): 页码
• page_size (int): 页大小

Response#

• status_code (int): 状态码，200表示成功
• status_message (string): 状态信息
• data (dict): 返回的数据

  • items (list) 数据列表

    • document_type (int): 知识库类型 0全部 1文本 2表格 3图片 4音频 5应用 6网址 7问答
    • expired_time (datetime): 知识库过期时间
    • name: (string): 知识库名称
    • id: (int): 知识库ID
    • description: (string): 知识库描述
    • total_file_size: (string): 知识库文件总大小
    • file_count: (int): 知识库文件数
    • team_id: (int): 团队ID
    • user_id: (int): 用户ID
    • permission: (string): 权限 write read all
    • user_name: (string): 创建者
    • never_expired: (int): 是否永不过期 0有有效期 1永久有效
    • tags: (list): 标签列表
      • tag_id: (int): 标签ID
      • tag_name: (str): 标签名称

  • page_num: (int): 页码

  • page_size: (int): 页大小

响应示例#

{
  "status_code": 200,
  "status_message": "SUCCESS",
  "data": {
    "items": [
      {
        "document_type": 1,
        "expired_time": null,
        "name": "文件夹测试",
        "id": 515,
        "description": "测试测试测试测试还是测试该知识库包含以下几个方面内容的文件.xls.txt\n- 福州美食攻略.pdf\n- 1.txt\n- 测试文件夹1\n- 测试文件夹2\n- git_tag.txt\n- 测试文件夹3.txt\n- 测试文件夹3\n- 字体.txt",
        "total_file_size": "41.14 KB",
        "file_count": 7,
        "team_id": null,
        "user_id": 1,
        "permission": "all",
        "user_name": "admin1",
        "tags": [
          {
            "tag_id": 1072,
            "tag_name": "lhy-text-1"
          }
        ],
        "never_expired": 1
      }
    ],
    "total": 1,
    "page_num": "1",
    "page_size": 10
  }
}